/*
 * Copyright (c) 2011 Imre Fazekas.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the Brillien nor the names of its
 * terms and concepts may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.vii.brillien.core.component.spi;

import com.vii.brillien.kernel.axiom.component.State;

/**
 * Abstract implementation of interface State. Defines the basic structure and behaviod of a state.
 */
public abstract class AbstractState implements State {

    /**
     * Default init state name for all Presence instances
     */
    public static final String COLLABLE_INIT_NAME = "CallableInit";

    /**
     * Default exit state name for all Presence instances
     */
    public static final String COLLABLE_EXIT_NAME = "CallableExit";

    /**
     * Default error state name for all Presence instances
     */
    public static final String COLLABLE_ERROR_NAME = "CallableError";

    /**
     * Indicates whether this State is active,init,error or exit state
     */
    protected boolean           active, init, error, exit;

    /**
     * Name of the State
     */
    protected String            name;

    {
        active = false;
    }


    public AbstractState() {

    }


    public AbstractState(String name, boolean init, boolean error, boolean exit) {
        this.name = name;
        this.init = init;
        this.error = error;
        this.exit = exit;
    }

    @Override
    public boolean isError() {
        return error;
    }

    @Override
    public boolean isExit() {
        return exit;
    }

    @Override
    public boolean isInit() {
        return init;  
    }

    /**
     * Set method for field active
     */
    public void setActive(boolean active) {
        init = false;
        this.active = active;
    }

    @Override
    public boolean isActive() {
        return active;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public void setName(String name) {
        this.name = name;
    }

    public void setInit(boolean init) {
        this.init = init;
    }

    public void setError(boolean error) {
        this.error = error;
    }

    public void setExit(boolean exit) {
        this.exit = exit;
    }

    /**
     * State equality decided by name equality
     */
    public boolean equals(AbstractState a) {
        return name.equals( a.name );
    }

    @Override
    public boolean equals(Object o) {
        return o instanceof AbstractState && equals( (AbstractState)o );
    }

}
